/*

  MMetaverseSurface

  Copyright (c) 2009 Mary Jane Soft - Marlon J. Manrique
	
  http://www.maryjanesoft.com
  http://www.marlonj.com

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.
 
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

  $Id$
	
*/

using TUIO;

namespace mjs.mmetaverse.surface
{
	/// <summary>
	///  Information about the avatar to use inside the MMetaverseSurface.
	///  The information for each avatar is the fiducial id, the names and 
	///  password.
	/// </summary>
	public class AvatarInfo
	{
		private int fiducialID;
		private string firstname;
		private string lastname;
		private string password;

		/// <summary>
		/// Create a new information from an Avatar.
		/// </summary>
		/// <param name="fiducialID">
		/// The fiducial id use in the reacTIVision table. <see cref="System.Int32"/>
		/// </param>
		/// <param name="firstname">
		/// The Avatar first name. <see cref="System.String"/>
		/// </param>
		/// <param name="lastname">
		/// The Avatar last name. <see cref="System.String"/>
		/// </param>
		/// <param name="password">
		/// The Avatar plain password use to authenticate. <see cref="System.String"/>
		/// </param>
		public AvatarInfo(int fiducialID, string firstname, string lastname, string password)
		{
			this.fiducialID = fiducialID;
			this.firstname = firstname;
			this.lastname = lastname;
			this.password = password;
		}

		/// <summary>
		/// Return the fiducial identifier use in the reacTIVision.
		/// </summary>
		/// <returns>
		/// The fiducial identifier identifier. <see cref="System.Int32"/>
		/// </returns>
		public int getFiducialID() 
		{
			return fiducialID;
		}

		/// <summary>
		/// Return the first name of the avatar.
		/// </summary>
		/// <returns>
		/// First name of the avatar. <see cref="System.String"/>
		/// </returns>
		public string getFirstname() 
		{
			return firstname;
		}

		/// <summary>
		/// Return the last name of the avatar.
		/// </summary>
		/// <returns>
		/// Return the last name of the avatar. <see cref="System.String"/>
		/// </returns>
		public string getLastname() 
		{
			return lastname;
		}

		/// <summary>
		/// Return the password of the avatar.
		/// </summary>
		/// <returns>
		/// The password of the avatar <see cref="System.String"/>
		/// </returns>
		public string getPassword() 
		{
			return password;
		}
	}
}